Zum Hauptinhalt springen

API — Branding — admin

Documentacao tecnica gerada automaticamente a partir da especificacao OpenAPI.


GET /api/branding

Get Branding

Exemplo resposta (200):

{
"primary_color": null,
"secondary_color": null,
"accent_color": null,
"logo_url": null,
"banner_url": null,
"hero_url": null,
"tagline": null,
"about_text": null,
"cta_text": null,
"show_categories": true,
"show_featured": true,
"social_instagram": null,
"social_facebook": null,
"social_whatsapp": null,
"social_tiktok": null,
"social_twitter": null,
"social_youtube": null,
"phone": null,
"email": null,
"address": null,
"city": null
}

PUT /api/branding

Update Branding

Corpo do pedido:

CampoTipoObrigatorioDescricao
primary_colorobjectNaoPrimary Color
secondary_colorobjectNaoSecondary Color
accent_colorobjectNaoAccent Color
logo_urlobjectNaoLogo Url
banner_urlobjectNaoBanner Url
hero_urlobjectNaoHero Url
taglineobjectNaoTagline
about_textobjectNaoAbout Text
cta_textobjectNaoCta Text
show_categoriesobjectNaoShow Categories
show_featuredobjectNaoShow Featured
social_instagramobjectNaoSocial Instagram
social_facebookobjectNaoSocial Facebook
social_whatsappobjectNaoSocial Whatsapp
social_tiktokobjectNaoSocial Tiktok
social_twitterobjectNaoSocial Twitter
social_youtubeobjectNaoSocial Youtube
phoneobjectNaoPhone
emailobjectNaoEmail
addressobjectNaoAddress
cityobjectNaoCity

Exemplo pedido:

{
"primary_color": null,
"secondary_color": null,
"accent_color": null,
"logo_url": null,
"banner_url": null,
"hero_url": null,
"tagline": null,
"about_text": null,
"cta_text": null,
"show_categories": null,
"show_featured": null,
"social_instagram": null,
"social_facebook": null,
"social_whatsapp": null,
"social_tiktok": null,
"social_twitter": null,
"social_youtube": null,
"phone": null,
"email": null,
"address": null,
"city": null
}

Exemplo resposta (200):

{
"primary_color": null,
"secondary_color": null,
"accent_color": null,
"logo_url": null,
"banner_url": null,
"hero_url": null,
"tagline": null,
"about_text": null,
"cta_text": null,
"show_categories": true,
"show_featured": true,
"social_instagram": null,
"social_facebook": null,
"social_whatsapp": null,
"social_tiktok": null,
"social_twitter": null,
"social_youtube": null,
"phone": null,
"email": null,
"address": null,
"city": null
}

Erros possiveis: 422 Validation Error


POST /api/branding/upload/{image_type}

Upload Branding Image Endpoint

Parametros:

NomeTipoObrigatorioDescricao
image_typestringSim

Exemplo resposta (201):

{
"url": "string",
"image_type": "string"
}

Erros possiveis: 422 Validation Error


Documentacao gerada automaticamente.